<?php

/**
 * BaseWiki
 * 
 * @package ProjectPier Wiki
 * @author Alex Mayhew
 * @copyright 2008
 * @version $Id$
 * @access public
 */
abstract class BaseWiki extends DataManager
{

  static private $columns = array(
  'id' 						=> DATA_TYPE_INTEGER, 
	'project_id' 		=> DATA_TYPE_INTEGER, 
	'revision' 			=> DATA_TYPE_INTEGER,
	'project_index'	=> DATA_TYPE_BOOLEAN,
	'project_sidebar'	=>	DATA_TYPE_BOOLEAN,
	); 

  /**
   * Construct
   * 
   * @return void
   */
  function __construct()
  {
    parent::__construct('WikiPage', 'wiki_pages');
  }// __construct

  /**
   * Return array of object columns
   *
   * @access public
   * @param void
   * @return array
   */
  function getColumns()
  {
    return array_keys(self::$columns);
  } // getColumns
  
 /**
  * Return column type
  *
  * @access public
  * @param string $column_name
  * @return string
  */
  function getColumnType($column_name) {
    if (isset(self::$columns[$column_name])) {
      return self::$columns[$column_name];
    } else {
      return DATA_TYPE_STRING;
    } // if
  } // getColumnType
  
  /**
  * Return array of PK columns. If only one column is PK returns its name as string
  *
  * @access public
  * @param void
  * @return array or string
  */
  function getPkColumns() {
    return 'id';
  } // getPkColumns
  
  /**
  * Return name of first auto_incremenent column if it exists
  *
  * @access public
  * @param void
  * @return string
  */
  function getAutoIncrementColumn() {
    return 'id';
  } // getAutoIncrementColumn
    
  /**
   * Returns an instance of the Wiki class
   *
   * @return
   */
    function instance()
    {
		static $instance;
		if(!instance_of($instance, 'Wiki')){
			$instance = new Wiki;
		}
		return $instance;
	} // instance
	
	/**
    * Return number of rows in this table
    *
    * @access public
    * @param string $conditions Query conditions
    * @return integer
    */
    function count($condition = null) {
      if (isset($this) && instance_of($this, 'Wiki')) {
        return parent::count($condition);
      } else {
        return Wiki::instance()->count($condition);
      } // if
    } // count
	
	/**
    * Delete rows that match specific conditions. If $conditions is NULL all rows from table will be deleted
    *
    * @access public
    * @param string $conditions Query conditions
    * @return boolean
    */
    function delete($condition = null) {
      if (isset($this) && instance_of($this, 'Wiki')) {
        return parent::delete($condition);
      } else {
        return Wiki::instance()->delete($condition);
      } // if
    } // delete
    
    // -------------------------------------------------------
    //  Finders
    // -------------------------------------------------------
    
    /**
    * Do a SELECT query over database with specified arguments
    *
    * @access public
    * @param array $arguments Array of query arguments. Fields:
    * 
    *  - one - select first row
    *  - conditions - additional conditions
    *  - order - order by string
    *  - offset - limit offset, valid only if limit is present
    *  - limit
    * 
    * @return one or Users objects
    * @throws DBQueryError
    */
    function find($arguments = null) {
      if (isset($this) && instance_of($this, 'Wiki')) {
        return parent::find($arguments);
      } else {
        return Wiki::instance()->find($arguments);
      } // if
    } // find
    
    /**
    * Find all records
    *
    * @access public
    * @param array $arguments
    * @return one or Users objects
    */
    function findAll($arguments = null) {
      if (isset($this) && instance_of($this, 'Wiki')) {
        return parent::findAll($arguments);
      } else {
        return Wiki::instance()->findAll($arguments);
      } // if
    } // findAll
    
    /**
    * Find one specific record
    *
    * @access public
    * @param array $arguments
    * @return Wiki Page 
    */
    function findOne($arguments = null) {
      if (isset($this) && instance_of($this, 'Wiki')) {
        return parent::findOne($arguments);
      } else {
        return Wiki::instance()->findOne($arguments);
      } // if
    } // findOne
    
    /**
    * Return object by its PK value
    *
    * @access public
    * @param mixed $id
    * @param boolean $force_reload If true cache will be skipped and data will be loaded from database
    * @return User 
    */
    function findById($id, $force_reload = false) {
      if (isset($this) && instance_of($this, 'Wiki')) {
        return parent::findById($id, $force_reload);
      } else {
        return Wiki::instance()->findById($id, $force_reload);
      } // if
    } // findById
    
    /**
    * This function will return paginated result. Result is an array where first element is 
    * array of returned object and second populated pagination object that can be used for 
    * obtaining and rendering pagination data using various helpers.
    * 
    * Items and pagination array vars are indexed with 0 for items and 1 for pagination
    * because you can't use associative indexing with list() construct
    *
    * @access public
    * @param array $arguments Query argumens (@see find()) Limit and offset are ignored!
    * @param integer $items_per_page Number of items per page
    * @param integer $current_page Current page number
    * @return array
    */
    function paginate($arguments = null, $items_per_page = 10, $current_page = 1) {
      if (isset($this) && instance_of($this, 'Wiki')) {
        return parent::paginate($arguments, $items_per_page, $current_page);
      } else {
        return Wiki::instance()->paginate($arguments, $items_per_page, $current_page);
      } // if
    } // paginate
}

?>